Acciones

Agregue un nombre y una descripción, y aplique la configuración específica de la acción.

Nombre

Un nombre único para la acción. El nombre se utiliza al seleccionar objetos de negocio para acciones en Object y Process Studio.

Descripción

Una descripción opcional para proporcionar más información sobre la acción.

Habilitado

Las acciones deben estar habilitadas para estar disponibles para su selección en objetos y procesos.

Habilitar parámetro de salida de datos de solicitud

Cuando se selecciona, crea una salida de datos de solicitud para una acción en Object Studio y Process Studio. Cuando se ejecuta una acción, el elemento de datos asociado se completa con los datos de solicitud de API.

Deshabilitar envío de solicitud

Cuando se selecciona esta opción, se generan los datos de la solicitud, pero la solicitud no se envía al servidor. Utilice junto con Habilitar parámetro de salida de datos de solicitud para generar una solicitud sin comunicarse con el servidor y ofrecer un mecanismo para depurar y evaluar solicitudes.

Estos parámetros son específicos de la acción y se utilizan en combinación con los parámetros habituales como entradas para una acción en objetos y procesos. Cuando están entre corchetes, los nombres de los parámetros se utilizan dinámicamente para agregar sus valores a las URL, los valores de encabezado y los cuerpos de solicitud.

Para obtener más información, consulte Parámetros.

Defina la solicitud HTTP que se realizará a este punto extremo de API seleccionando el método HTTP requerido y agregando la ruta de URL, el contenido del cuerpo y los encabezados.

Método

El método HTTP utilizado para la solicitud. El menú desplegable contiene los métodos HTTP estándar, pero cualquier verbo de solicitud se puede ingresar en el campo de texto libre. La validación se realiza en el campo para evitar la entrada de caracteres no permitidos.

Ruta de la URL

La ruta de URL particular a la acción que define la solicitud específica cuando se utiliza con la URL base. La ruta URL puede parametrizarse con parámetros comunes y específicos de la solicitud, entre corchetes.

Por ejemplo, la URL base es la siguiente:

http://staff.database.com

La ruta URL es la siguiente:

/api/[version]/employee/[id]

Cuando los parámetros se expanden y se agregan a la URL base, se realiza una solicitud a esta dirección:

http://staff.database.com/api/v1/employee/26855

Cuerpo

Configure el contenido que se enviará con la solicitud HTTP utilizando uno de los siguientes tipos de contenido:

• Ninguno: la solicitud no incluye el contenido del cuerpo. Esto es habitual para las acciones que recuperan información, como aquellas que utilizan el método GET.
• Plantilla: envía contenido del cuerpo basado en texto como JSON o XML. Los parámetros se pueden utilizar para agregar datos al cuerpo de la solicitud.
• Archivo único: envía archivos como parte de la solicitud de API. La definición de API especifica un parámetro de entrada que se utiliza para hacer referencia a un archivo desde una fase de datos en un proceso.
• Múltiples archivos: envíe varios archivos como parte de la solicitud de API. La definición de API especifica un parámetro de entrada que se utiliza para hacer referencia a archivos desde una fase de colección en un proceso.
• Custom Code: para situaciones complejas, el cuerpo de la solicitud puede generarse utilizando el código. Cuando sea necesario, esto puede incorporar el código del área de código común de la definición de API.

Encabezados (específicos de la acción)

Agregue un nombre y un valor para cada encabezado específico de esta acción. Los encabezados utilizados en una solicitud son una combinación de los encabezados comunes en la definición de API y los encabezados establecidos en el nivel de acción. Si un encabezado de acción específica tiene el mismo nombre que un encabezado común, el valor de la acción específica se utiliza en cualquier solicitud.

Para obtener más información, consulte Encabezados.

Transforme la respuesta HTTP utilizando la ruta JSON o el código personalizado para extraer los datos requeridos. Los datos se pueden almacenar en elementos de datos, lo que facilita su uso en otras fases de un objeto o proceso. El código personalizado se puede utilizar para configurar respuestas más complejas, por ejemplo, realizar cálculos en los datos de respuesta.

La salida de respuesta se define utilizando los siguientes campos:

• Parámetro: el nombre del parámetro de salida creado para almacenar los datos especificados.
• Tipo de datos: el tipo de datos del parámetro de salida.
• Método: el método puede ser ruta JSON o código personalizado. Si se utiliza el código personalizado, las salidas son parámetros de referencia que deben asignarse.
• Ruta JSON: si se utiliza la ruta JSON, la expresión necesaria para extraer elementos específicos de JSON en los parámetros de salida. Estos parámetros de salida tienen un tipo de datos de Blue Prism especificado, y el objeto encontrado con la ruta JSON se convertirá a ese tipo de datos.
• Para obtener más información sobre la configuración de respuestas, consulte Extracción de datos de respuesta con la ruta JSON.